Security News
NIST Misses 2024 Deadline to Clear NVD Backlog
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
braintree-jsdoc-template
Advanced tools
Note! This is not in any way made by me, I simply published it to NPM for convenience.
A clean, responsive documentation template with search and navigation highlighting for JSDoc 3. Forked from github.com/nijikokun/minami.
Clone repository to your designated jsdoc
template directory, then:
In your projects package.json
file add a generate script:
"script": {
"generate-docs": "node_modules/.bin/jsdoc --configure .jsdoc.json --verbose"
}
In your .jsdoc.json
file, add a template option.
"opts": {
"template": "node_modules/jsdoc-template"
}
{
"tags": {
"allowUnknownTags": true,
"dictionaries": ["jsdoc"]
},
"source": {
"include": ["lib", "package.json", "README.md"],
"includePattern": ".js$",
"excludePattern": "(node_modules/|docs)"
},
"plugins": [
"plugins/markdown"
],
"templates": {
"referenceTitle": "My SDK Name",
"disableSort": false,
"collapse": true,
"resources": {
"google": "https://www.google.com/"
}
},
"opts": {
"destination": "./docs/",
"encoding": "utf8",
"private": true,
"recurse": true,
"template": "./node_modules/jsdoc-template"
}
}
Note: referenceTitle
and disableSort
will affect the output of this theme.
If you would like to enable Algolia DocSearch, you can pass a search
object into the templates
object.
"templates": {
"search": {
"apiKey": "your-api-key",
"indexName": "Your index name. Defaults to braintree.",
"hitsPerPage": "Number of Results to show. Defaults to 7.",
}
}
Licensed under the Apache2 license.
3.3.0
FAQs
Braintree JSDoc 3 Template
The npm package braintree-jsdoc-template receives a total of 6,761 weekly downloads. As such, braintree-jsdoc-template popularity was classified as popular.
We found that braintree-jsdoc-template demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
Security News
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.